GET Channels as Select List

Overview

---

The table below provides key details about the GET method for listing channels.

Get Channels as Select List
Method	GET
URL or Endpoint	/api/v1/projectId/channels/select-list
Headers	Authorization
Parameters	projectId

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

The request does not include request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "canGoLive": true,
    "canRewind": true,
    "logo": "string",
    "channelType": "string",
    "id": 0,
    "name": "string",
    "value": "string",
    "description": "string"
  },
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	Indicates if the request was successful.
errors	array[string]	List of error messages, if any.
messages	array[string]	List of informational or response messages from the back end.
result	object	Contains the main response data.
canGoLive	bool	Indicates whether a channel can go live.
canRewind	bool	Indicates if the channel allows rewinding.
logo	string (URL)	URL for the channel's logo.
channelType	string	Type of the channel.
id	integer	Unique identifier of the channel.
name	string	Name of the channel.
value	string	Unique identifier or key associated with the channel.
description	string	Description of the channel.
resultInfo	string	Additional information about the result.
statusCode	integer	HTTP status code returned by the response.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed